home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 (Alt) / MACD 5.bin / workbench / tools / czesc_4 / wisecrack / wisecrack.doc < prev    next >
Encoding:
Text File  |  1992-03-30  |  5.0 KB  |  123 lines
  1.                         *************************
  2.                              WiseCrack V1.0
  3.                              March 23, 1992
  4.                         *************************
  5.  
  6. Contents:
  7. =========
  8. 1. What is WiseCrack?
  9. 2. CLI usage
  10. 3. WorkBench usage
  11. 4. Installation
  12. 5. Datafile format
  13. 6. Disclaimer
  14.  
  15.  
  16. 1. What is WiseCrack?
  17. ---------------------
  18.     Wisecrack is a fortune cookie program. When started, it prints a 
  19. random message from a message database. This kind of program is very 
  20. popular on Un*x systems. WiseCrack can be run from either the CLI or the 
  21. WorkBench, and it can open it's own window for the message.
  22.     What use has this program? Well, even when using a hard-disk the 
  23. startup-sequence can take some time to finish. So with installing 
  24. WiseCrack to be run from the startup-sequence, it can give you something 
  25. else (possibly funny) to look at than the usual startup messages. This 
  26. is the way I am using it. (Yes, I *am* using it myself.)
  27.     Since I haven't got 2.0 myself yet, I haven't tried it on a 2.0 
  28. system. But I think it should run on both systems. 
  29.  
  30. 2. CLI usage
  31. ------------
  32.     WiseCrack [-w] [file]
  33.     
  34. Options:
  35. -w  
  36.     Makes WiseCrack open its own window for the text. Without this option
  37.     WiseCrack will write the text to standard output.
  38.     
  39. file
  40.     The filename for the file WiseCrack will use to search for it's 
  41.     messages. If the datafile is in another directory than the current, 
  42.     you must specify the whole path.
  43.     If no filename is given, WiseCrack will use 'S:WiseCrack.Dat' as 
  44.     default.
  45.     
  46. -? | -h | ?
  47.     Anyone of these options will print out the version number and a short
  48.     usage description.
  49.     
  50. Example:
  51.  
  52.     WiseCrack -w SYS:Data/messages.dat
  53.  
  54. will make WiseCrack open a window for the message it found in the file 
  55. messages.dat in the directory SYS:Data.
  56.     
  57. 3. WorkBench usage
  58. ------------------
  59. To start WiseCrack from WorkBench simply double-click on it's icon. When 
  60. WiseCrack is run from the WorkBench it automatically opens it's own 
  61. window for the output.
  62. To specify an alternative file instead of the default 'S:WiseCrack.Dat' 
  63. use the tooltype 'DATAFILE'. For example:
  64.  
  65. DATAFILE=sys:etc/Limericks.Dat 
  66.  
  67. will make WiseCrack pick a message from the file Limericks.Dat in the 
  68. directory sys:etc.
  69.  
  70. 4. Installation
  71. ---------------
  72.      You can copy 'Wisecrack' and 'WiseCrack.Dat' to anywhere you want. 
  73. As mentioned before, the default is for WiseCrack to look for the file 
  74. 'WiseCrack.Dat' in S:. But if you want the datafile another place, you
  75. must either call WiseCrack with the full path to the datafile (from CLI), 
  76. or use the tooltype option in the icon (see above).
  77.     WiseCrack uses the icon.library (system library) and reqtools.library
  78. (included in this distribution), so both must be present in libs:. The 
  79. reqtools.library is a shared library made by Nico François. (See 7. 
  80. Disclaimer). There are to versions of this library, an 1.3 version and a 
  81. 2.0 version. To install reqtools.library, simply double-click on the 
  82. InstallLibrary icon.
  83.     If you want to run WiseCrack at startup, edit the S:Startup-Sequence 
  84. and put it somewhere at the start. (Ref. section 2: CLI usage). If you 
  85. use the -w option, you might want to run WiseCrack in the background. 
  86. This can be done by 'Run >NIL: <NIL: WiseCrack -w'.
  87.     If you have WorkBench 2.0 you can instead drag the WiseCrack icon into 
  88. the WbStartup drawer. Since I haven't got 2.0 myself yet, I have not tried 
  89. this. (Ref. section 3: WorkBench usage).
  90.  
  91. 5. Datafile format
  92. ------------------
  93. The datafile is an ordinary text file, so it should be easy to create 
  94. your own datafile, or add messages to the existing datafile. The only 
  95. thing special is that each new message starts with a backslash '\'. Take a 
  96. look at the file 'example.dat' for an example of how to make a datafile.
  97. Since the reqtools.library requester is a bit fuzzy about very long 
  98. lines, you should try not to use lines longer than 72 characters.
  99.  
  100. 6. Disclaimer (I should have one, shouldn't I? Every one else has. :-)
  101. -------------
  102.     The program and the source is public domain. I claim NO copyright at 
  103. all. That means you can do whatever you want with it. You can copy it, give
  104. it to friends, post it on BBS's, edit, use or change the source all you 
  105. want. You can even sell it (if you can find anyone who would want to pay 
  106. for it :-). 
  107.     There is only one restriction, and that is on the reqtools.library. 
  108. ReqTools library is copyright (c) Nico François (of PowerPacker fame), 
  109. and should be treated thereafter. The ReqTools library is a really great 
  110. tool, you should try it if you haven't already. (Great work Nico!)
  111.     As I already has mentioned there is no need to send me any money for 
  112. this. I am just happy to contribute with something to the Amiga 
  113. community. Since this is my first release on the Amiga, I would like to 
  114. hear from you if you have any comment or (hopefully not) bug reports.
  115. Here is my adress:
  116.             
  117.             Lars Magnus Nordeide
  118.             Odinsgate 8
  119.             N-4300 Sandnes
  120.             NORWAY
  121.             
  122. Until July 1st, 1992, you can also use my email adress larsm@ii.uib.no
  123.